CLOUDP-271988: IPA-102: Validate paths follow expected format #312
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tools/spectral/ipa/rulesets/functions/eachPathAlternatesBetweenResourceNameAndPathParam.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/eachPathAlternatesBetweenResourceNameAndPathParam.js
Show resolved
Hide resolved
| description: "APIs must provide a get method for resources. http://go/ipa/104" | ||
| message: "{{error}} http://go/ipa/117" | ||
| description: 'APIs must provide a get method for resources. http://go/ipa/104' | ||
| message: '{{error}} http://go/ipa/104' |
tools/spectral/ipa/__tests__/eachPathAlternatesBetweenResourceNameAndPathParam.test.js
Outdated
Show resolved
Hide resolved
gssbzn
reviewed
Dec 17, 2024
| const validatePathStructure = (elements) => { | ||
| return elements.every((element, index) => { | ||
| const isEvenIndex = index % 2 === 0; | ||
| return isEvenIndex ? !isPathParam(element) : isPathParam(element); |
There was a problem hiding this comment.
Suggested change
| return isEvenIndex ? !isPathParam(element) : isPathParam(element); | |
| return isEvenIndex && !isPathParam(element); |
There was a problem hiding this comment.
When the index is odd, it will return false this way. Am I missing anything?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Jira ticket: CLOUDP-271988
Implements a rule under IPA-102, which checks if the paths are alternating between resource name and path param.
Assumptions:
api/atlas/v2or/api/atlas/v2/unauthprefixesapi/atlas/v2or/api/atlas/v2/unauthby themselves are valid pathspathParamis in the format of{[a-z][a-zA-Z0-9]*}or{[a-z][a-zA-Z0-9]*}:[a-z][a-zA-Z0-9]*if custom methods attachedresourceNameand alternates withpathParampathParamorresourceNamefor the cases such ascamelCaseorpluralityChecklist
Changes to Spectral
Further comments